Update doc-comments to match recent documentation tidy-ups.

Signed-off-by: Ewan Mellor <ewan@xensource.com>

diff --git a/tools/libxen/include/xen_console.h b/tools/libxen/include/xen_console.h
index 450c142637f82c498e38241d83520336fdfdc6d5..d8c8f508df70e9b84602f32e6e3afe700a30ce1a 100644 (file)
--- a/tools/libxen/include/xen_console.h
+++ b/tools/libxen/include/xen_console.h
@@ -149,14 +149,14 @@ xen_console_record_opt_set_free(xen_console_record_opt_set *set);
 
 
 /**
- * Get the current state of the given console.
+ * Get a record containing the current state of the given console.
  */
 extern bool
 xen_console_get_record(xen_session *session, xen_console_record **result, xen_console console);
 
 
 /**
- * Get a reference to the object with the specified UUID.
+ * Get a reference to the console instance with the specified UUID.
  */
 extern bool
 xen_console_get_by_uuid(xen_session *session, xen_console *result, char *uuid);

diff --git a/tools/libxen/include/xen_host.h b/tools/libxen/include/xen_host.h
index 2264b603e4c8266c599abf7b9037cd1f89b48ccf..5b1a4dca8a92ef67e6d603451b5c1a0275188106 100644 (file)
--- a/tools/libxen/include/xen_host.h
+++ b/tools/libxen/include/xen_host.h
@@ -154,14 +154,14 @@ xen_host_record_opt_set_free(xen_host_record_opt_set *set);
 
 
 /**
- * Get the current state of the given host.  !!!
+ * Get a record containing the current state of the given host.
  */
 extern bool
 xen_host_get_record(xen_session *session, xen_host_record **result, xen_host host);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the host instance with the specified UUID.
  */
 extern bool
 xen_host_get_by_uuid(xen_session *session, xen_host *result, char *uuid);

diff --git a/tools/libxen/include/xen_host_cpu.h b/tools/libxen/include/xen_host_cpu.h
index e0d4ee0c4b9eac697fdbbf4be79947b7cc618dc2..15aee488d49c44d513e9606bfde0fc83efdc0605 100644 (file)
--- a/tools/libxen/include/xen_host_cpu.h
+++ b/tools/libxen/include/xen_host_cpu.h
@@ -153,14 +153,14 @@ xen_host_cpu_record_opt_set_free(xen_host_cpu_record_opt_set *set);
 
 
 /**
- * Get the current state of the given host_cpu.  !!!
+ * Get a record containing the current state of the given host_cpu.
  */
 extern bool
 xen_host_cpu_get_record(xen_session *session, xen_host_cpu_record **result, xen_host_cpu host_cpu);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the host_cpu instance with the specified UUID.
  */
 extern bool
 xen_host_cpu_get_by_uuid(xen_session *session, xen_host_cpu *result, char *uuid);

diff --git a/tools/libxen/include/xen_network.h b/tools/libxen/include/xen_network.h
index a25babe4922d86acbf581306c5f68b0d5307050c..228c7c2ab42c79239f4e90d51d7b5ec50936fc4f 100644 (file)
--- a/tools/libxen/include/xen_network.h
+++ b/tools/libxen/include/xen_network.h
@@ -152,14 +152,14 @@ xen_network_record_opt_set_free(xen_network_record_opt_set *set);
 
 
 /**
- * Get the current state of the given network.  !!!
+ * Get a record containing the current state of the given network.
  */
 extern bool
 xen_network_get_record(xen_session *session, xen_network_record **result, xen_network network);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the network instance with the specified UUID.
  */
 extern bool
 xen_network_get_by_uuid(xen_session *session, xen_network *result, char *uuid);

diff --git a/tools/libxen/include/xen_pif.h b/tools/libxen/include/xen_pif.h
index 143ba5709a0dea53f87d0c0dc32a2ad1eb4f3010..edc2b5a83b67792231708f30f09385837bd4d1ec 100644 (file)
--- a/tools/libxen/include/xen_pif.h
+++ b/tools/libxen/include/xen_pif.h
@@ -155,14 +155,14 @@ xen_pif_record_opt_set_free(xen_pif_record_opt_set *set);
 
 
 /**
- * Get the current state of the given PIF.  !!!
+ * Get a record containing the current state of the given PIF.
  */
 extern bool
 xen_pif_get_record(xen_session *session, xen_pif_record **result, xen_pif pif);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the PIF instance with the specified UUID.
  */
 extern bool
 xen_pif_get_by_uuid(xen_session *session, xen_pif *result, char *uuid);

diff --git a/tools/libxen/include/xen_sr.h b/tools/libxen/include/xen_sr.h
index 8359b5737b44a4be8b009a33c18294be95a2e2dc..eb8a420149e111e7b78085365863a0b57ffaf55a 100644 (file)
--- a/tools/libxen/include/xen_sr.h
+++ b/tools/libxen/include/xen_sr.h
@@ -153,14 +153,14 @@ xen_sr_record_opt_set_free(xen_sr_record_opt_set *set);
 
 
 /**
- * Get the current state of the given SR.  !!!
+ * Get a record containing the current state of the given SR.
  */
 extern bool
 xen_sr_get_record(xen_session *session, xen_sr_record **result, xen_sr sr);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the SR instance with the specified UUID.
  */
 extern bool
 xen_sr_get_by_uuid(xen_session *session, xen_sr *result, char *uuid);

diff --git a/tools/libxen/include/xen_user.h b/tools/libxen/include/xen_user.h
index b42682558571938a49f1c2ea9619cc4526b19bae..cce9ba8302d26568e1ef0f5e51572f68b9d9299d 100644 (file)
--- a/tools/libxen/include/xen_user.h
+++ b/tools/libxen/include/xen_user.h
@@ -146,14 +146,14 @@ xen_user_record_opt_set_free(xen_user_record_opt_set *set);
 
 
 /**
- * Get the current state of the given user.  !!!
+ * Get a record containing the current state of the given user.
  */
 extern bool
 xen_user_get_record(xen_session *session, xen_user_record **result, xen_user user);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the user instance with the specified UUID.
  */
 extern bool
 xen_user_get_by_uuid(xen_session *session, xen_user *result, char *uuid);

diff --git a/tools/libxen/include/xen_vdi.h b/tools/libxen/include/xen_vdi.h
index ba20f755c6924e611ca084c98f44c40e0bfcee6d..cfdbc6a61cefe1c024d41ee4aae2b319df90c26c 100644 (file)
--- a/tools/libxen/include/xen_vdi.h
+++ b/tools/libxen/include/xen_vdi.h
@@ -159,14 +159,14 @@ xen_vdi_record_opt_set_free(xen_vdi_record_opt_set *set);
 
 
 /**
- * Get the current state of the given VDI.  !!!
+ * Get a record containing the current state of the given VDI.
  */
 extern bool
 xen_vdi_get_record(xen_session *session, xen_vdi_record **result, xen_vdi vdi);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the VDI instance with the specified UUID.
  */
 extern bool
 xen_vdi_get_by_uuid(xen_session *session, xen_vdi *result, char *uuid);

diff --git a/tools/libxen/include/xen_vif.h b/tools/libxen/include/xen_vif.h
index 8930a7849fc93d003d9d99c05983f764e2a129cb..4efc3f08513bcdc3a61ac5eca31967e959041d37 100644 (file)
--- a/tools/libxen/include/xen_vif.h
+++ b/tools/libxen/include/xen_vif.h
@@ -156,14 +156,14 @@ xen_vif_record_opt_set_free(xen_vif_record_opt_set *set);
 
 
 /**
- * Get the current state of the given VIF.  !!!
+ * Get a record containing the current state of the given VIF.
  */
 extern bool
 xen_vif_get_record(xen_session *session, xen_vif_record **result, xen_vif vif);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the VIF instance with the specified UUID.
  */
 extern bool
 xen_vif_get_by_uuid(xen_session *session, xen_vif *result, char *uuid);

diff --git a/tools/libxen/include/xen_vtpm.h b/tools/libxen/include/xen_vtpm.h
index f55d74217b96a39be8c217de114e969a6e67ff08..a04c8d4de36427ba07eda61f478b9c73d5b0a230 100644 (file)
--- a/tools/libxen/include/xen_vtpm.h
+++ b/tools/libxen/include/xen_vtpm.h
@@ -151,14 +151,14 @@ xen_vtpm_record_opt_set_free(xen_vtpm_record_opt_set *set);
 
 
 /**
- * Get the current state of the given VTPM.  !!!
+ * Get a record containing the current state of the given VTPM.
  */
 extern bool
 xen_vtpm_get_record(xen_session *session, xen_vtpm_record **result, xen_vtpm vtpm);
 
 
 /**
- * Get a reference to the object with the specified UUID.  !!!
+ * Get a reference to the VTPM instance with the specified UUID.
  */
 extern bool
 xen_vtpm_get_by_uuid(xen_session *session, xen_vtpm *result, char *uuid);